Get Corporate Employee List
GET : http://<base_url>/digipay/v3/user/corporate_employee
This API is utilized to add a new corporate employee to the system.
QUERY PARAMS:-
Parameter | Type | Description | Value |
---|---|---|---|
corporate_id | String | it is a unique id assigned to the corporate detail | 123 |
is_active | Boolean | if value is true it will show active languages in response, if value is false it will show inActive langauages in response | true/false |
skip | Int | Skip the first n document from the query result | 1 |
limit | Int | Limits the number of records or documents that you want | 1 |
start_date | Long | a Unix timestamp value in second | 1 |
end_date | Long | a Unix timestamp value in second | 1 |
sorting | String | Sorting acs or des | 123 |
search_keyword | String | a keyword which can be either name of language or a language code to get desired language as output | 123 |
HEADERS:-
Parameter | Type | Description | Value |
---|---|---|---|
Authorization | String | It is a combination of type and token to authenticate user for the given token | Token duik7309njdlkhdauhknksadhjkas986876sd873j |
CompanyID | String | Company_id is a unique primary id, that is represent company detail | 76bc712200ca444fa334f9e55e5fd7a8 |
Request Body:-
Request Example
curl --request GET \
--url 'http://192.168.1.102:8014/digipay/v3/user/corporate_employee?Corporate_id=unique%20id%20assigned%20to%20the%20employee%20to%20retrive%20corporate%20employee%20Detail&is_active=false&skip=1&limit=1&start_date=1&end_date=1&serach_keyword=123' \
--header 'Authorization: Token duik7309njdlkhdauhknksadhjkas986876sd873j' \
--header 'CompnanyID: 7753ad6bd8cf48f5b1312fd21eb36588' \
--header 'accept: application/json'
Response:-
Response 200(OK)
{
"success": 1,
"error": [],
"data": {
"corporate_employee" : {
"id": "b9a4cbeeedd340509cb1ac628cae2973",
"user_id": "1",
"user_type": 1,
"corporate_id": "123"
"is_active": true,
"created_date": 1658894024
}
}
}
Response 400(BAD REQUEST)
{
"success": 0,
"error"": [1],
"data": {
"message": "BAD_REQUEST",
}
}
RESPONSES :-
Status Code | Description |
---|---|
200 | OK |
400 | BAD REQUEST |
404 | NOT FOUND |
500 | INTERNAL SERVER ERROR |